docs: Use entity for version

Meson's gtk-doc support currently requires the main SGML/XML file
to be located in the srcdir, so instead of substituting the module
version in that file directly, use a small auxiliary file that's
included via a custom entity.

https://bugzilla.gnome.org/show_bug.cgi?id=783229

diff --git a/configure.ac b/configure.ac
index 916d7c108879fbd3ad81fb01335999afefe0a519..db30125df6c415eca2dc431223bd582ded34fdfc 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -254,9 +254,9 @@ AC_CONFIG_FILES([
   docs/Makefile
   docs/reference/Makefile
   docs/reference/shell/Makefile
-  docs/reference/shell/shell-docs.sgml
+  docs/reference/shell/version.xml
   docs/reference/st/Makefile
-  docs/reference/st/st-docs.sgml
+  docs/reference/st/version.xml
   js/Makefile
   src/Makefile
   subprojects/gvc/Makefile

diff --git a/docs/reference/shell/Makefile.am b/docs/reference/shell/Makefile.am
index ad3a3defe8c7c32cac1a14ef4c96b9c3f67da126..715e3f26cb251522625c54375d1b359139fdc959 100644 (file)
--- a/docs/reference/shell/Makefile.am
+++ b/docs/reference/shell/Makefile.am
@@ -120,7 +120,7 @@ include $(top_srcdir)/gtk-doc.make
 
 # Other files to distribute
 # e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST +=
+EXTRA_DIST += version.xml.in
 
 # Files not to distribute
 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types

diff --git a/docs/reference/shell/shell-docs.sgml b/docs/reference/shell/shell-docs.sgml
new file mode 100644 (file)
index 0000000..c349f84
--- /dev/null
+++ b/docs/reference/shell/shell-docs.sgml
@@ -0,0 +1,69 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+  <!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index">
+  <bookinfo>
+    <title>Shell Reference Manual</title>
+    <releaseinfo>
+      for Shell &version;.
+      <!--The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="http://[SERVER]/shell/index.html">http://[SERVER]/shell/</ulink>.-->
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>Actors</title>
+    <xi:include href="xml/shell-generic-container.xml"/>
+    <xi:include href="xml/shell-stack.xml"/>
+  </chapter>
+  <chapter>
+    <title>Application tracking</title>
+    <xi:include href="xml/shell-app.xml"/>
+    <xi:include href="xml/shell-app-usage.xml"/>
+    <xi:include href="xml/shell-window-tracker.xml"/>
+  </chapter>
+  <chapter>
+    <title>Search</title>
+    <xi:include href="xml/shell-app-system.xml"/>
+  </chapter>
+  <chapter>
+    <title>Tray Icons</title>
+    <xi:include href="xml/shell-embedded-window.xml"/>
+    <xi:include href="xml/shell-gtk-embed.xml"/>
+    <xi:include href="xml/shell-tray-icon.xml"/>
+    <xi:include href="xml/shell-tray-manager.xml"/>
+  </chapter>
+  <chapter>
+    <title>Recorder</title>
+    <xi:include href="xml/shell-recorder.xml"/>
+  </chapter>
+  <chapter>
+    <title>Integration helpers and utilities</title>
+    <xi:include href="doc-gen-org.gnome.Shell.SearchProvider.xml"/>
+    <xi:include href="doc-gen-org.gnome.Shell.SearchProvider2.xml"/>
+    <xi:include href="xml/shell-global.xml"/>
+    <xi:include href="xml/shell-action-modes.xml"/>
+    <xi:include href="xml/shell-wm.xml"/>
+    <xi:include href="xml/shell-util.xml"/>
+    <xi:include href="xml/shell-mount-operation.xml"/>
+    <xi:include href="xml/shell-polkit-authentication-agent.xml"/>
+  </chapter>
+  <chapter id="object-tree">
+    <title>Object Hierarchy</title>
+     <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
+  <index id="api-index-full">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="deprecated-api-index" role="deprecated">
+    <title>Index of deprecated API</title>
+    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>

diff --git a/docs/reference/shell/shell-docs.sgml.in b/docs/reference/shell/shell-docs.sgml.in
deleted file mode 100644 (file)
index 14a9cf1..0000000
--- a/docs/reference/shell/shell-docs.sgml.in
+++ /dev/null
@@ -1,68 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
-[
-  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
-]>
-<book id="index">
-  <bookinfo>
-    <title>Shell Reference Manual</title>
-    <releaseinfo>
-      for Shell @VERSION@.
-      <!--The latest version of this documentation can be found on-line at
-      <ulink role="online-location" url="http://[SERVER]/shell/index.html">http://[SERVER]/shell/</ulink>.-->
-    </releaseinfo>
-  </bookinfo>
-
-  <chapter>
-    <title>Actors</title>
-    <xi:include href="xml/shell-generic-container.xml"/>
-    <xi:include href="xml/shell-stack.xml"/>
-  </chapter>
-  <chapter>
-    <title>Application tracking</title>
-    <xi:include href="xml/shell-app.xml"/>
-    <xi:include href="xml/shell-app-usage.xml"/>
-    <xi:include href="xml/shell-window-tracker.xml"/>
-  </chapter>
-  <chapter>
-    <title>Search</title>
-    <xi:include href="xml/shell-app-system.xml"/>
-  </chapter>
-  <chapter>
-    <title>Tray Icons</title>
-    <xi:include href="xml/shell-embedded-window.xml"/>
-    <xi:include href="xml/shell-gtk-embed.xml"/>
-    <xi:include href="xml/shell-tray-icon.xml"/>
-    <xi:include href="xml/shell-tray-manager.xml"/>
-  </chapter>
-  <chapter>
-    <title>Recorder</title>
-    <xi:include href="xml/shell-recorder.xml"/>
-  </chapter>
-  <chapter>
-    <title>Integration helpers and utilities</title>
-    <xi:include href="doc-gen-org.gnome.Shell.SearchProvider.xml"/>
-    <xi:include href="doc-gen-org.gnome.Shell.SearchProvider2.xml"/>
-    <xi:include href="xml/shell-global.xml"/>
-    <xi:include href="xml/shell-action-modes.xml"/>
-    <xi:include href="xml/shell-wm.xml"/>
-    <xi:include href="xml/shell-util.xml"/>
-    <xi:include href="xml/shell-mount-operation.xml"/>
-    <xi:include href="xml/shell-polkit-authentication-agent.xml"/>
-  </chapter>
-  <chapter id="object-tree">
-    <title>Object Hierarchy</title>
-     <xi:include href="xml/tree_index.sgml"/>
-  </chapter>
-  <index id="api-index-full">
-    <title>API Index</title>
-    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="deprecated-api-index" role="deprecated">
-    <title>Index of deprecated API</title>
-    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
-  </index>
-
-  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
-</book>

diff --git a/docs/reference/shell/version.xml.in b/docs/reference/shell/version.xml.in
new file mode 100644 (file)
index 0000000..d78bda9
--- /dev/null
+++ b/docs/reference/shell/version.xml.in
@@ -0,0 +1 @@
+@VERSION@

diff --git a/docs/reference/st/Makefile.am b/docs/reference/st/Makefile.am
index 18e837d244bd7048319af2955c1f4648be53177f..df2d357d5667c64f3257ef028dcb7ebb5f4ab782 100644 (file)
--- a/docs/reference/st/Makefile.am
+++ b/docs/reference/st/Makefile.am
@@ -85,7 +85,7 @@ include $(top_srcdir)/gtk-doc.make
 
 # Other files to distribute
 # e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST +=
+EXTRA_DIST += version.xml.in
 
 # Files not to distribute
 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types

diff --git a/docs/reference/st/st-docs.sgml b/docs/reference/st/st-docs.sgml
new file mode 100644 (file)
index 0000000..788c204
--- /dev/null
+++ b/docs/reference/st/st-docs.sgml
@@ -0,0 +1,64 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+  <!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index">
+  <bookinfo>
+    <title>St Reference Manual</title>
+    <releaseinfo>
+      for St &version;.
+      <!--The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="http://[SERVER]/st/index.html">http://[SERVER]/st/</ulink>.-->
+    </releaseinfo>
+  </bookinfo>
+
+  <part>
+    <title>API reference</title>
+    <chapter id="base">
+      <title>Abstract classes and Interfaces</title>
+      <xi:include href="xml/st-widget.xml"/>
+      <xi:include href="xml/st-widget-accessible.xml"/>
+      <xi:include href="xml/st-scrollable.xml"/>
+    </chapter>
+    <chapter id="widgets">
+      <title>Widgets</title>
+      <xi:include href="xml/st-button.xml"/>
+      <xi:include href="xml/st-drawing-area.xml"/>
+      <xi:include href="xml/st-entry.xml"/>
+      <xi:include href="xml/st-icon.xml"/>
+      <xi:include href="xml/st-label.xml"/>
+    </chapter>
+    <chapter id="containers">
+      <title>Containers</title>
+      <xi:include href="xml/st-bin.xml"/>
+      <xi:include href="xml/st-box-layout.xml"/>
+      <xi:include href="xml/st-scroll-view.xml"/>
+    </chapter>
+
+    <chapter id="styling">
+      <title>Styling</title>
+      <xi:include href="xml/st-theme.xml"/>
+      <xi:include href="xml/st-theme-context.xml"/>
+      <xi:include href="xml/st-theme-node.xml"/>
+      <xi:include href="xml/st-theme-node-transition.xml"/>
+      <xi:include href="xml/st-texture-cache.xml"/>
+    </chapter>
+  </part>
+  <chapter id="object-tree">
+    <title>Object Hierarchy</title>
+     <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
+  <index id="api-index-full">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="deprecated-api-index" role="deprecated">
+    <title>Index of deprecated API</title>
+    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>

diff --git a/docs/reference/st/st-docs.sgml.in b/docs/reference/st/st-docs.sgml.in
deleted file mode 100644 (file)
index f5df261..0000000
--- a/docs/reference/st/st-docs.sgml.in
+++ /dev/null
@@ -1,63 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
-[
-  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
-]>
-<book id="index">
-  <bookinfo>
-    <title>St Reference Manual</title>
-    <releaseinfo>
-      for St @VERSION@.
-      <!--The latest version of this documentation can be found on-line at
-      <ulink role="online-location" url="http://[SERVER]/st/index.html">http://[SERVER]/st/</ulink>.-->
-    </releaseinfo>
-  </bookinfo>
-
-  <part>
-    <title>API reference</title>
-    <chapter id="base">
-      <title>Abstract classes and Interfaces</title>
-      <xi:include href="xml/st-widget.xml"/>
-      <xi:include href="xml/st-widget-accessible.xml"/>
-      <xi:include href="xml/st-scrollable.xml"/>
-    </chapter>
-    <chapter id="widgets">
-      <title>Widgets</title>
-      <xi:include href="xml/st-button.xml"/>
-      <xi:include href="xml/st-drawing-area.xml"/>
-      <xi:include href="xml/st-entry.xml"/>
-      <xi:include href="xml/st-icon.xml"/>
-      <xi:include href="xml/st-label.xml"/>
-    </chapter>
-    <chapter id="containers">
-      <title>Containers</title>
-      <xi:include href="xml/st-bin.xml"/>
-      <xi:include href="xml/st-box-layout.xml"/>
-      <xi:include href="xml/st-scroll-view.xml"/>
-    </chapter>
-
-    <chapter id="styling">
-      <title>Styling</title>
-      <xi:include href="xml/st-theme.xml"/>
-      <xi:include href="xml/st-theme-context.xml"/>
-      <xi:include href="xml/st-theme-node.xml"/>
-      <xi:include href="xml/st-theme-node-transition.xml"/>
-      <xi:include href="xml/st-texture-cache.xml"/>
-    </chapter>
-  </part>
-  <chapter id="object-tree">
-    <title>Object Hierarchy</title>
-     <xi:include href="xml/tree_index.sgml"/>
-  </chapter>
-  <index id="api-index-full">
-    <title>API Index</title>
-    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="deprecated-api-index" role="deprecated">
-    <title>Index of deprecated API</title>
-    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
-  </index>
-
-  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
-</book>

diff --git a/docs/reference/st/version.xml.in b/docs/reference/st/version.xml.in
new file mode 100644 (file)
index 0000000..d78bda9
--- /dev/null
+++ b/docs/reference/st/version.xml.in
@@ -0,0 +1 @@
+@VERSION@